Skip to content

Commit

Permalink
chore: update references to identus
Browse files Browse the repository at this point in the history 
from:
https://github.com/hyperledger-labs/open-enterprise-agent
https://maven.pkg.github.com/hyperledger-labs/open-enterprise-agent
https://raw.githubusercontent.com/hyperledger-labs/open-enterprise-agent

to:
https://github.com/hyperledger/identus
https://maven.pkg.github.com/hyperledger/identus
https://raw.githubusercontent.com/hyperledger/identus

Signed-off-by: Kranium Gikos Mendoza <kraniumgikos.mendoza@iohk.io>
  • Loading branch information
@womfoo
womfoo committed Apr 16, 2024
1 parent 32cd9e6 commit 091f877
Show file tree
Hide file tree
Showing 12 changed files with 156 additions and 156 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
To submit a new issue, please, use one of the following templates:

https://github.com/hyperledger-labs/open-enterprise-agent/issues/new/choose
https://github.com/hyperledger/identus/issues/new/choose

Thank you!
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Link to any discussion, related issues and bug reports to give the context to he
Link to existing ADR (Architecture Decision Record), if any. If relevant, describe other approaches explored and the selected approach. Documenting why the methods were not selected will create a knowledge base for future reference, helping prevent others from revisiting less optimal ideas.

### Checklist:
- [ ] My PR follows the [contribution guidelines](https://github.com/hyperledger-labs/open-enterprise-agent/blob/main/CONTRIBUTING.md) of this project
- [ ] My PR follows the [contribution guidelines](https://github.com/hyperledger/identus/blob/main/CONTRIBUTING.md) of this project
- [ ] My PR is free of third-party dependencies that don't comply with the [Allowlist](https://toc.hyperledger.org/governing-documents/allowed-third-party-license-policy.html#approved-licenses-for-allowlist)
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
Expand Down
214 changes: 107 additions & 107 deletions CHANGELOG.md
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion SECURITY.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The Open Enterprise Agent (OEA) team and community take security bugs in the components of the OEA ecosystem seriously. We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions.

To report a security issue, please use the GitHub Security Advisory ["Report a Vulnerability"](https://github.com/hyperledger-labs/open-enterprise-agent/security/advisories/new) tab.
To report a security issue, please use the GitHub Security Advisory ["Report a Vulnerability"](https://github.com/hyperledger/identus/security/advisories/new) tab.

The OEA team will send a response indicating the next steps in handling your report. After the initial reply to your report, the security team will keep you informed of the progress towards a fix and full announcement, and may ask for additional information or guidance.

Expand Down
34 changes: 17 additions & 17 deletions docs/decisions/20240116-use-zio-failures-and-defects-effectively.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ way to recover
from an SQL execution error in a database-agnostic way.

A good approach is to use ZIO Defects to report repository errors, declaring all repository methods as `URIO`
or `UIO`([example](https://github.com/hyperledger-labs/open-enterprise-agent/blob/main/connect/lib/core/src/main/scala/io/iohk/atala/connect/core/repository/ConnectionRepository.scala)).
or `UIO`([example](https://github.com/hyperledger/identus/blob/main/connect/lib/core/src/main/scala/io/iohk/atala/connect/core/repository/ConnectionRepository.scala)).
Conversely, declaring them as `Task` assumes that the caller (i.e. service) can properly handle and
recover from the low-level and database-specific exceptions exposed in the error channel, which is a fallacy.

Expand All @@ -251,7 +251,7 @@ trait ConnectionRepository {
```

Converting a ZIO `Task` to ZIO `UIO` can easily be done
using `ZIO#orDie`([example](https://github.com/hyperledger-labs/open-enterprise-agent/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/connect/lib/sql-doobie/src/main/scala/io/iohk/atala/connect/sql/repository/JdbcConnectionRepository.scala#L114)).
using `ZIO#orDie`([example](https://github.com/hyperledger/identus/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/connect/lib/sql-doobie/src/main/scala/io/iohk/atala/connect/sql/repository/JdbcConnectionRepository.scala#L114)).

```scala
class JdbcConnectionRepository(xa: Transactor[ContextAwareTask], xb: Transactor[Task]) extends ConnectionRepository {
Expand All @@ -276,7 +276,7 @@ class JdbcConnectionRepository(xa: Transactor[ContextAwareTask], xb: Transactor[
```

For those cases where one has to generate a defect, a common way to do this is by using the following ZIO
construct ([example](https://github.com/hyperledger-labs/open-enterprise-agent/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/connect/lib/sql-doobie/src/main/scala/io/iohk/atala/connect/sql/repository/JdbcConnectionRepository.scala#L212)):
construct ([example](https://github.com/hyperledger/identus/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/connect/lib/sql-doobie/src/main/scala/io/iohk/atala/connect/sql/repository/JdbcConnectionRepository.scala#L212)):

```scala
class JdbcConnectionRepository(xa: Transactor[ContextAwareTask], xb: Transactor[Task]) extends ConnectionRepository {
Expand All @@ -293,11 +293,11 @@ class JdbcConnectionRepository(xa: Transactor[ContextAwareTask], xb: Transactor[
Follow the `get` and `find` best practices in the repository interface for read operations:

- `getXxx()` returns the requested record or throws an unexpected exception/defect when not
found ([example](https://github.com/hyperledger-labs/open-enterprise-agent/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/connect/lib/core/src/main/scala/io/iohk/atala/connect/core/repository/ConnectionRepository.scala#L36)).
found ([example](https://github.com/hyperledger/identus/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/connect/lib/core/src/main/scala/io/iohk/atala/connect/core/repository/ConnectionRepository.scala#L36)).
- `findXxx()` returns an `Option` with or without the request record, which allows the caller service to handle
the `found`
and `not-found` cases and report appropriately to the end
user ([example](https://github.com/hyperledger-labs/open-enterprise-agent/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/connect/lib/core/src/main/scala/io/iohk/atala/connect/core/repository/ConnectionRepository.scala#L32)).
user ([example](https://github.com/hyperledger/identus/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/connect/lib/core/src/main/scala/io/iohk/atala/connect/core/repository/ConnectionRepository.scala#L32)).

```scala
trait ConnectionRepository {
Expand All @@ -312,7 +312,7 @@ trait ConnectionRepository {
The `create`, `update` or `delete` repository methods should not return an `Int` indicating the number of rows affected
by the operation but either return `Unit` when successful or throw an exception/defect when the row count is not what is
expected, like i.e. an update operation resulting in a `0` affected row
count ([example](https://github.com/hyperledger-labs/open-enterprise-agent/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/connect/lib/sql-doobie/src/main/scala/io/iohk/atala/connect/sql/repository/JdbcConnectionRepository.scala#L85)).
count ([example](https://github.com/hyperledger/identus/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/connect/lib/sql-doobie/src/main/scala/io/iohk/atala/connect/sql/repository/JdbcConnectionRepository.scala#L85)).

```scala
class JdbcConnectionRepository(xa: Transactor[ContextAwareTask], xb: Transactor[Task]) extends ConnectionRepository {
Expand Down Expand Up @@ -358,7 +358,7 @@ caught at the upper level and returns a generic `500 Internal Server Error` to t

For those cases where a specific error like `404` should be returned, it is up to the service to first call `find()`
before `update()` and construct a `NotFound` failure, propagated through the error channel, if it gives
a `None` ([example](https://github.com/hyperledger-labs/open-enterprise-agent/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/connect/lib/core/src/main/scala/io/iohk/atala/connect/core/service/ConnectionServiceImpl.scala#L149)).
a `None` ([example](https://github.com/hyperledger/identus/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/connect/lib/core/src/main/scala/io/iohk/atala/connect/core/service/ConnectionServiceImpl.scala#L149)).

Relying on the service layer to implement it will guarantee consistent behavior regardless of the underlying database
type (could be different RDMS flavor, No-SQL, etc.).
Expand All @@ -382,22 +382,22 @@ class ConnectionServiceImpl() extends ConnectionService {
#### Do not type unexpected errors

Do not wrap defects from lower layers (typically repository) in a failure and error case class declarations
like [this](https://github.com/hyperledger-labs/open-enterprise-agent/blob/b579fd86ab96db711425f511154e74be75583896/connect/lib/core/src/main/scala/io/iohk/atala/connect/core/model/error/ConnectionServiceError.scala#L8)
like [this](https://github.com/hyperledger/identus/blob/b579fd86ab96db711425f511154e74be75583896/connect/lib/core/src/main/scala/io/iohk/atala/connect/core/model/error/ConnectionServiceError.scala#L8)
should be prohibited.

Considering that failures are viewed as **expected errors** from which users can potentially recover, error case classes
like `UnexpectedError` should be
prohibited ([example](https://github.com/hyperledger-labs/open-enterprise-agent/blob/b579fd86ab96db711425f511154e74be75583896/connect/lib/core/src/main/scala/io/iohk/atala/connect/core/model/error/ConnectionServiceError.scala#L12)).
prohibited ([example](https://github.com/hyperledger/identus/blob/b579fd86ab96db711425f511154e74be75583896/connect/lib/core/src/main/scala/io/iohk/atala/connect/core/model/error/ConnectionServiceError.scala#L12)).

#### Extend the common `Failure` trait

Make sure all service errors extend the shared
trait [`io.iohk.atala.shared.models.Failure`](https://github.com/hyperledger-labs/open-enterprise-agent/blob/main/shared/src/main/scala/io/iohk/atala/shared/models/Failure.scala).
trait [`io.iohk.atala.shared.models.Failure`](https://github.com/hyperledger/identus/blob/main/shared/src/main/scala/io/iohk/atala/shared/models/Failure.scala).
This allows handling "at the end of the world“ to be done in a consistent and in generic way.

Create an exhaustive and meaningful list of service errors and make sure the value of the `userFacingMessage` attribute
is chosen wisely! It will present "as is" to the user and should not contain any sensitive
data ([example](https://github.com/hyperledger-labs/open-enterprise-agent/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/connect/lib/core/src/main/scala/io/iohk/atala/connect/core/model/error/ConnectionServiceError.scala#L14)).
data ([example](https://github.com/hyperledger/identus/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/connect/lib/core/src/main/scala/io/iohk/atala/connect/core/model/error/ConnectionServiceError.scala#L14)).

```scala
trait Failure {
Expand Down Expand Up @@ -470,7 +470,7 @@ object ConnectionServiceError {
#### Use Scala 3 Union Types

Use Scala 3 union-types declaration in the effect’s error channel to notify the caller of potential
failures ([example](https://github.com/hyperledger-labs/open-enterprise-agent/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/connect/lib/core/src/main/scala/io/iohk/atala/connect/core/service/ConnectionServiceImpl.scala#L178))
failures ([example](https://github.com/hyperledger/identus/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/connect/lib/core/src/main/scala/io/iohk/atala/connect/core/service/ConnectionServiceImpl.scala#L178))

````scala
class ConnectionServiceImpl() extends ConnectionService {
Expand All @@ -490,9 +490,9 @@ The upper layer will automatically do so appropriately and consistently using Ta
#### Reporting RFC-9457 Error Response

All declared Tapir endpoints must
use [`io.iohk.atala.api.http.ErrorResponse`](https://github.com/hyperledger-labs/open-enterprise-agent/blob/main/prism-agent/service/server/src/main/scala/io/iohk/atala/api/http/ErrorResponse.scala)
use [`io.iohk.atala.api.http.ErrorResponse`](https://github.com/hyperledger/identus/blob/main/prism-agent/service/server/src/main/scala/io/iohk/atala/api/http/ErrorResponse.scala)
as their output error
type ([example](https://github.com/hyperledger-labs/open-enterprise-agent/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/prism-agent/service/server/src/main/scala/io/iohk/atala/connect/controller/ConnectionEndpoints.scala#L45))
type ([example](https://github.com/hyperledger/identus/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/prism-agent/service/server/src/main/scala/io/iohk/atala/connect/controller/ConnectionEndpoints.scala#L45))
This type ensures that the response returned to the user complies with
the [RFC-9457 Problem Details for HTTP APIs](https://www.rfc-editor.org/rfc/rfc9457.html).

Expand All @@ -514,11 +514,11 @@ object ConnectionEndpoints {

If all the underlying services used by a controller comply with the above rules, then the only error type that could
propagate through the effect’s error channel is the
parent [`io.iohk.atala.shared.models.Failure`](https://github.com/hyperledger-labs/open-enterprise-agent/blob/main/shared/src/main/scala/io/iohk/atala/shared/models/Failure.scala)
parent [`io.iohk.atala.shared.models.Failure`](https://github.com/hyperledger/identus/blob/main/shared/src/main/scala/io/iohk/atala/shared/models/Failure.scala)
type and its conversion
to the ErrorResponse type is done automatically
via [Scala implicit conversion](https://github.com/hyperledger-labs/open-enterprise-agent/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/prism-agent/service/server/src/main/scala/io/iohk/atala/api/http/ErrorResponse.scala#L44).
via [Scala implicit conversion](https://github.com/hyperledger/identus/blob/eb898e068f768507d6979a5d9bab35ef7ad4a045/prism-agent/service/server/src/main/scala/io/iohk/atala/api/http/ErrorResponse.scala#L44).

#### Do not reflexively log errors

The upper layer will automatically do so appropriately and consistently using Tapir interceptor customization.
The upper layer will automatically do so appropriately and consistently using Tapir interceptor customization.
Loading

0 comments on commit 091f877

Please sign in to comment.