Skip to content
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

Jump to bottom

Add feature to support custom now_utc implementations #1397

Merged
merged 7 commits into from
Sep 2, 2024
Merged

Add feature to support custom now_utc implementations #1397

merged 7 commits into from
Sep 2, 2024

Conversation

frederikrothenberger
Copy link
Contributor

@frederikrothenberger frederikrothenberger commented Aug 23, 2024 •
edited by itsyaasir
Loading

Description of change

This PR adds a feature to identity_core to allow specifying a custom function to get the current time (Timestamp::now_utc). The feature is disabled by default.

Fixes #1391.

Type of change

Add an x to the boxes that are relevant to your changes.

  • Bug fix (a non-breaking change which fixes an issue)
  • Enhancement (a non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Fix

How the change has been tested

Added an integration test to identity_core that uses the custom hook.

Change checklist

Add an x to the boxes that are relevant to your changes.

  • I have followed the contribution guidelines for this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
    @itsyaasir: does this feature require more documentation?
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@frederikrothenberger frederikrothenberger requested a review from a team as a code owner August 23, 2024 11:43
@frederikrothenberger frederikrothenberger changed the title Add feature to support custom not_utc implementations Add feature to support custom now_utc implementations Aug 23, 2024
@frederikrothenberger frederikrothenberger mentioned this pull request Aug 23, 2024
Closed
@frederikrothenberger
Copy link
Contributor Author

@itsyaasir @UMR1352: There will need to be some CI changes as cargo test --workspace --all-features no longer compiles (since the test binaries are missing the custom time implementation but have custom_time enabled).

I.e. testing will need to be split into cargo test --test custom_time --features="custom_time" and running all other tests with custom_time disabled.

I did not touch CI (yet). How would you want me to approach that issue?

@itsyaasir
Copy link
Contributor

@itsyaasir @UMR1352: There will need to be some CI changes as cargo test --workspace --all-features no longer compiles (since the test binaries are missing the custom time implementation but have custom_time enabled).

I.e. testing will need to be split into cargo test --test custom_time --features="custom_time" and running all other tests with custom_time disabled.

I did not touch CI (yet). How would you want me to approach that issue?

Yeah, I think splitting it will make sense in the CI

itsyaasir
itsyaasir reviewed Aug 23, 2024
View reviewed changes
Copy link
Contributor

@itsyaasir itsyaasir left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for opening this PR, everything is looking fine to me 👍🏾 .

Let us get the CI passing now.

@eike-hass
Copy link
Collaborator

@itsyaasir @UMR1352: There will need to be some CI changes as cargo test --workspace --all-features no longer compiles (since the test binaries are missing the custom time implementation but have custom_time enabled).

I.e. testing will need to be split into cargo test --test custom_time --features="custom_time" and running all other tests with custom_time disabled.

I did not touch CI (yet). How would you want me to approach that issue?

We will take care of CI 👌

@frederikrothenberger
Copy link
Contributor Author

Thanks a lot!

@eike-hass eike-hass added Wasm Related to Wasm bindings. Becomes part of the Wasm changelog Added A new feature that requires a minor release. Part of "Added" section in changelog Rust Related to the core Rust code. Becomes part of the Rust changelog. labels Aug 26, 2024
@frederikrothenberger
Copy link
Contributor Author

@itsyaasir: In order to successfully compile identity_core for the target wasm32-unknown-unknown without having a dependency on js-sys, I needed to do the following additional changes: frederikrothenberger@3dd5198

Could we include that commit in this PR as well, or would you rather have that separately?

@itsyaasir
Copy link
Contributor

@itsyaasir: In order to successfully compile identity_core for the target wasm32-unknown-unknown without having a dependency on js-sys, I needed to do the following additional changes: frederikrothenberger@3dd5198

Could we include that commit in this PR as well, or would you rather have that separately?

You can add it in this PR, no problem

@eike-hass
Copy link
Collaborator

eike-hass commented Aug 29, 2024 •
edited
Loading

@frederikrothenberger could you try to re-sign your commits? 🙏
Edit: Might mean you need to force push the branch

@frederikrothenberger
Add feature to support custom now_utc implementations
1ce8f33 
This PR adds a feature to `identity_core` to allow specifying a custom
function to get the current time (`Timestamp::now_utc`).
The feature is disabled by default.

Closes iotaledger#1391.
@frederikrothenberger
Formatting
4deaa59
@frederikrothenberger
Fix wrong comment
dde896d
@itsyaasir @frederikrothenberger
chore: clippy fixes and fmt
f67cb5e
@itsyaasir @frederikrothenberger
chore: clippy fixes and fmt
2fda099
@frederikrothenberger
Allow compilation for target wasm32-unknown-unknown without js-sys
989e6ca 
Also removes the unused dependency on `iota-crypto` (which also had
a dependency on `js-sys` through the `random` feature).
@frederikrothenberger
Copy link
Contributor Author

@eike-hass: The commits are now signed 👍

@itsyaasir
Copy link
Contributor

@frederikrothenberger Thanks for the contribution.

@itsyaasir itsyaasir merged commit 842f483 into iotaledger:main Sep 2, 2024
15 checks passed
frederikrothenberger added a commit to frederikrothenberger/identity.rs that referenced this pull request Sep 2, 2024
@frederikrothenberger
Mark js-sys as optional for identity_core
424d08e 
In iotaledger#1397 my intention was to make the `js-sys` dependency mutually
exclusive with the feature `custom_time`. As it turns out, it's not that
simple and mixing target specific dependencies with feature specific
dependencies does not actually work. See [here](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#platform-specific-dependencies)
and [here](https://doc.rust-lang.org/cargo/reference/features.html#mutually-exclusive-features).

So this removes the broken feature reference in the dependency declaration
and instead marks it as `optional`.
frederikrothenberger added a commit to frederikrothenberger/identity.rs that referenced this pull request Sep 2, 2024
@frederikrothenberger
Mark js-sys as optional for identity_core
ccebdb1 
In iotaledger#1397 my intention was to make the `js-sys` dependency mutually
exclusive with the feature `custom_time`. As it turns out, it's not that
simple and mixing target specific dependencies with feature specific
dependencies does not actually work. See [here](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#platform-specific-dependencies)
and [here](https://doc.rust-lang.org/cargo/reference/features.html#mutually-exclusive-features).

So this removes the broken feature reference in the dependency declaration
and instead marks it as `optional`. Also, the feature `custom_time` takes
precedence over `js-sys` so these do not actually conflict and one
_could_ enable both.
frederikrothenberger added a commit to frederikrothenberger/identity.rs that referenced this pull request Sep 2, 2024
@frederikrothenberger
Mark js-sys as optional for identity_core
e83158b 
In iotaledger#1397 my intention was to make the `js-sys` dependency mutually
exclusive with the feature `custom_time`. As it turns out, it's not that
simple and mixing target specific dependencies with feature specific
dependencies does not actually work. See [here](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#platform-specific-dependencies)
and [here](https://doc.rust-lang.org/cargo/reference/features.html#mutually-exclusive-features).

So this removes the broken feature reference in the dependency declaration
and instead marks it as `optional`. Also, the feature `custom_time` takes
precedence over `js-sys` so these do not actually conflict and one
_could_ enable both.
@frederikrothenberger frederikrothenberger mentioned this pull request Sep 2, 2024
Merged
10 tasks
itsyaasir added a commit that referenced this pull request Sep 4, 2024
@frederikrothenberger @itsyaasir
Mark js-sys as optional for identity_core (#1405)
84f1b7e 
* Mark `js-sys` as optional for identity_core

In #1397 my intention was to make the `js-sys` dependency mutually
exclusive with the feature `custom_time`. As it turns out, it's not that
simple and mixing target specific dependencies with feature specific
dependencies does not actually work. See [here](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#platform-specific-dependencies)
and [here](https://doc.rust-lang.org/cargo/reference/features.html#mutually-exclusive-features).

So this removes the broken feature reference in the dependency declaration
and instead marks it as `optional`. Also, the feature `custom_time` takes
precedence over `js-sys` so these do not actually conflict and one
_could_ enable both.

* Make js-sys a default feature

* Fix defaults switch

* Don't expose `js-sys` feature

Co-authored-by: Yasir <yasirshariffa@gmail.com>

---------

Co-authored-by: Yasir <yasirshariffa@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@itsyaasir itsyaasir itsyaasir approved these changes

@UMR1352 UMR1352 UMR1352 approved these changes

Assignees
No one assigned
Labels
Added A new feature that requires a minor release. Part of "Added" section in changelog Rust Related to the core Rust code. Becomes part of the Rust changelog. Wasm Related to Wasm bindings. Becomes part of the Wasm changelog
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Request] Remove (or make optional) dependency on time (Timestamp::now_utc())
4 participants
@frederikrothenberger @itsyaasir @eike-hass @UMR1352