Skip to content

fix(server,asana): return real error from /proceed-db-migration instead of bare 500 #9068

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bujjibabukatta wants to merge 1 commit into
base: main
Choose a base branch
from
+28 −5
Open

fix(server,asana): return real error from /proceed-db-migration instead of bare 500 #9068

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 23 additions & 2 deletions backend/plugins/asana/models/migrationscripts/20260509000001_encrypt_connection_token.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ limitations under the License.
package migrationscripts

import (
"fmt"

"github.com/apache/incubator-devlake/core/context"
"github.com/apache/incubator-devlake/core/dal"
"github.com/apache/incubator-devlake/core/errors"
Expand All @@ -39,7 +41,13 @@ func (*encryptConnectionToken) Up(basicRes context.BasicRes) errors.Error {
db := basicRes.GetDal()
encKey := basicRes.GetConfig(plugin.EncodeKeyEnvStr)
if encKey == "" {
return errors.BadInput.New("asana invalid encKey")
return errors.BadInput.New(
"ENCRYPTION_SECRET is not set — this is required to encrypt existing Asana connection " +
"tokens as part of this migration. Please set the ENCRYPTION_SECRET environment " +
"variable to the value of ENCODE_KEY from your previous deployment's .env file, " +
"then retry the migration. See https://devlake.apache.org/docs/GettingStarted/Upgrade/ " +
"for details.",
)
}

cursor, err := db.Cursor(dal.From(&asanaConnectionTokenPlain{}))
Expand All @@ -56,9 +64,22 @@ func (*encryptConnectionToken) Up(basicRes context.BasicRes) errors.Error {
if row.Token == "" {
continue
}

// Skip tokens already encrypted, so retries don't double-encrypt them.
if _, decryptErr := plugin.Decrypt(encKey, row.Token); decryptErr == nil {
continue
}

encryptedToken, err := plugin.Encrypt(encKey, row.Token)
if err != nil {
return err
return errors.Default.Wrap(err,
fmt.Sprintf(
"failed to encrypt token for asana connection id=%d — this usually means "+
"ENCRYPTION_SECRET does not match the ENCODE_KEY used to originally store "+
"this connection's token",
row.ID,
),
)
}
err = db.UpdateColumns(
row.TableName(),
Expand Down
8 changes: 5 additions & 3 deletions backend/server/api/api.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,9 +130,11 @@ func SetupApiServer(router *gin.Engine) {
// Endpoint to proceed database migration — listed in auth.publicPaths because
// auth tables may not exist yet when migration is pending.
router.GET("/proceed-db-migration", func(ctx *gin.Context) {
// Execute database migration
errors.Must(services.ExecuteMigration())
// Return success response
// Surface the real migration error to the client instead of a bare 500.
if err := services.ExecuteMigration(); err != nil {
shared.ApiOutputError(ctx, err)
return
}
shared.ApiOutputSuccess(ctx, nil, http.StatusOK)
})

Expand Down