feat(dl): support download file with file_regex param (#169)

example:

curl -v
"http://localhost:8000/oci-file/hub.pingcap.net/pingcap/tidb/package?tag=v8.3.0_linux_amd64&
file_regex=tidb-lightning-.%2A%5B.%5Dsha256"

to download the file with regex pattern `tidb-lightning-.*[.]sha256`.

Signed-off-by: wuhuizuo <[email protected]>

Signed-off-by: wuhuizuo <[email protected]>

dl/Dockerfile

@@ -1,4 +1,4 @@
-FROM golang:1.22.4 AS builder
+FROM golang:1.23.1 AS builder
 
 COPY . /app
 RUN --mount=type=cache,target=/go/pkg/mod cd /app && go build -o server ./cmd/server

dl/design/design.go

@@ -55,10 +55,21 @@ var _ = Service("oci", func() {
 
  Method("download-file", func() {
  Payload(func() {
- Field(1, "repository", String, "OCI artifact repository")
- Field(2, "tag", String, "OCI artifact tag")
- Field(3, "file", String, "file name in OCI artifact")
- Required("repository", "tag", "file")
+ Field(1, "repository", String, "OCI artifact repository", func() {
+ Example("hub.pingcap.net/pingcap/tidb/package")
+ })
+ Field(2, "tag", String, "OCI artifact tag", func() {
+ Example("v8.1.0_darwin_arm64")
+ })
+ Field(3, "file", String, "file name in OCI artifact", func() {
+ Example("tidb-v7.5.0-darwin-arm64.tar.gz")
+ })
+ Field(4, "file_regex", String, "file name regexp pattern", func() {
+ Format(FormatRegexp)
+ Example("tidb-.+[.]tar[.]gz")
+ })
+
+ Required("repository", "tag")
  })
 
  // The use of Result here illustrates how HTTP headers can still be
@@ -79,8 +90,9 @@ var _ = Service("oci", func() {
 
  HTTP(func() {
  GET("/oci-file/{*repository}")
- Param("file:file", String, "file name in OCI artifact")
- Param("tag:tag", String, "OCI artifact tag")
+ Param("tag", String, "OCI artifact tag")
+ Param("file", String, "file name in OCI artifact")
+ Param("file_regex", String, "file name regex pattern in OCI artifact")
 
  // Bypass response body encoder code generation to alleviate need for
  // loading the entire response body in memory.

dl/gen/http/openapi.json

@@ -1 +1 @@
-{"swagger":"2.0","info":{"title":"Download OCI artifacts Service","description":"Service for downloading files from OCI artifact","version":"0.0.1"},"host":"localhost:8000","consumes":["application/json","application/xml","application/gob"],"produces":["application/json","application/xml","application/gob"],"paths":{"/healthz":{"get":{"tags":["health"],"summary":"healthz health","operationId":"health#healthz","responses":{"200":{"description":"OK response.","schema":{"type":"boolean"}}},"schemes":["http"]}},"/livez":{"get":{"tags":["health"],"summary":"livez health","operationId":"health#livez","responses":{"200":{"description":"OK response.","schema":{"type":"boolean"}}},"schemes":["http"]}},"/oci-file-sha256/{repository}":{"get":{"tags":["oci"],"summary":"download-file-sha256 oci","operationId":"oci#download-file-sha256","produces":["application/plain-text"],"parameters":[{"name":"file","in":"query","description":"file name in OCI artifact","required":true,"type":"string"},{"name":"tag","in":"query","description":"OCI artifact tag","required":true,"type":"string"},{"name":"repository","in":"path","description":"OCI artifact repository","required":true,"type":"string"}],"responses":{"200":{"description":"OK response.","headers":{"Content-Disposition":{"description":"Content-Disposition header for downloading","type":"string"},"Content-Length":{"description":"Length is the downloaded content length in bytes.","type":"int64"}}}},"schemes":["http"]}},"/oci-file/{repository}":{"get":{"tags":["oci"],"summary":"download-file oci","operationId":"oci#download-file","produces":["application/octet-stream"],"parameters":[{"name":"file","in":"query","description":"file name in OCI artifact","required":true,"type":"string"},{"name":"tag","in":"query","description":"OCI artifact tag","required":true,"type":"string"},{"name":"repository","in":"path","description":"OCI artifact repository","required":true,"type":"string"}],"responses":{"200":{"description":"OK response.","headers":{"Content-Disposition":{"description":"Content-Disposition header for downloading","type":"string"},"Content-Length":{"description":"Length is the downloaded content length in bytes.","type":"int64"}}}},"schemes":["http"]}},"/oci-files/{repository}":{"get":{"tags":["oci"],"summary":"list-files oci","operationId":"oci#list-files","parameters":[{"name":"tag","in":"query","description":"OCI artifact tag","required":true,"type":"string"},{"name":"repository","in":"path","description":"OCI artifact repository","required":true,"type":"string"}],"responses":{"200":{"description":"OK response.","schema":{"type":"array","items":{"type":"string","example":"Nam quibusdam recusandae dolor voluptas."}}}},"schemes":["http"]}},"/s3-obj/{bucket}/{key}":{"get":{"tags":["ks3"],"summary":"download-object ks3","operationId":"ks3#download-object","produces":["application/octet-stream"],"parameters":[{"name":"bucket","in":"path","description":"bucket name","required":true,"type":"string"},{"name":"key","in":"path","description":"object key","required":true,"type":"string"}],"responses":{"200":{"description":"OK response.","headers":{"Content-Disposition":{"description":"Content-Disposition header for downloading","type":"string"},"Content-Length":{"description":"Length is the downloaded content length in bytes.","type":"int64"}}}},"schemes":["http"]}}}}
+{"swagger":"2.0","info":{"title":"Download OCI artifacts Service","description":"Service for downloading files from OCI artifact","version":"0.0.1"},"host":"localhost:8000","consumes":["application/json","application/xml","application/gob"],"produces":["application/json","application/xml","application/gob"],"paths":{"/healthz":{"get":{"tags":["health"],"summary":"healthz health","operationId":"health#healthz","responses":{"200":{"description":"OK response.","schema":{"type":"boolean"}}},"schemes":["http"]}},"/livez":{"get":{"tags":["health"],"summary":"livez health","operationId":"health#livez","responses":{"200":{"description":"OK response.","schema":{"type":"boolean"}}},"schemes":["http"]}},"/oci-file-sha256/{repository}":{"get":{"tags":["oci"],"summary":"download-file-sha256 oci","operationId":"oci#download-file-sha256","produces":["application/plain-text"],"parameters":[{"name":"file","in":"query","description":"file name in OCI artifact","required":true,"type":"string"},{"name":"tag","in":"query","description":"OCI artifact tag","required":true,"type":"string"},{"name":"repository","in":"path","description":"OCI artifact repository","required":true,"type":"string"}],"responses":{"200":{"description":"OK response.","headers":{"Content-Disposition":{"description":"Content-Disposition header for downloading","type":"string"},"Content-Length":{"description":"Length is the downloaded content length in bytes.","type":"int64"}}}},"schemes":["http"]}},"/oci-file/{repository}":{"get":{"tags":["oci"],"summary":"download-file oci","operationId":"oci#download-file","produces":["application/octet-stream"],"parameters":[{"name":"tag","in":"query","description":"OCI artifact tag","required":true,"type":"string"},{"name":"file","in":"query","description":"file name in OCI artifact","required":false,"type":"string"},{"name":"file_regex","in":"query","description":"file name regex pattern in OCI artifact","required":false,"type":"string","format":"regexp"},{"name":"repository","in":"path","description":"OCI artifact repository","required":true,"type":"string"}],"responses":{"200":{"description":"OK response.","headers":{"Content-Disposition":{"description":"Content-Disposition header for downloading","type":"string"},"Content-Length":{"description":"Length is the downloaded content length in bytes.","type":"int64"}}}},"schemes":["http"]}},"/oci-files/{repository}":{"get":{"tags":["oci"],"summary":"list-files oci","operationId":"oci#list-files","parameters":[{"name":"tag","in":"query","description":"OCI artifact tag","required":true,"type":"string"},{"name":"repository","in":"path","description":"OCI artifact repository","required":true,"type":"string"}],"responses":{"200":{"description":"OK response.","schema":{"type":"array","items":{"type":"string","example":"Et aut labore veniam et maiores qui."}}}},"schemes":["http"]}},"/s3-obj/{bucket}/{key}":{"get":{"tags":["ks3"],"summary":"download-object ks3","operationId":"ks3#download-object","produces":["application/octet-stream"],"parameters":[{"name":"bucket","in":"path","description":"bucket name","required":true,"type":"string"},{"name":"key","in":"path","description":"object key","required":true,"type":"string"}],"responses":{"200":{"description":"OK response.","headers":{"Content-Disposition":{"description":"Content-Disposition header for downloading","type":"string"},"Content-Length":{"description":"Length is the downloaded content length in bytes.","type":"int64"}}}},"schemes":["http"]}}}}

dl/gen/http/openapi.yaml

@@ -84,16 +84,22 @@ paths:
  produces:
  - application/octet-stream
  parameters:
+ - name: tag
+ in: query
+ description: OCI artifact tag
+ required: true
+ type: string
  - name: file
  in: query
  description: file name in OCI artifact
- required: true
+ required: false
  type: string
- - name: tag
+ - name: file_regex
  in: query
- description: OCI artifact tag
- required: true
+ description: file name regex pattern in OCI artifact
+ required: false
  type: string
+ format: regexp
  - name: repository
  in: path
  description: OCI artifact repository
@@ -135,7 +141,7 @@ paths:
  type: array
  items:
  type: string
- example: Nam quibusdam recusandae dolor voluptas.
+ example: Et aut labore veniam et maiores qui.
  schemes:
  - http
  /s3-obj/{bucket}/{key}: