Add internal package to libnavigation-core #2839

Guardiola31337 · 2020-04-25T00:59:43Z

Description

This PR adds internal package to libnavigation-core

Splitting #2417 in different PRs

As this is going to be a big refactor the plan here is to open small PRs and move stuff incrementally making the review easier. Even trying to do so this first PR included changes in 94 files 😱 (mostly moving files around)

I have added any issue links
I have added all related labels (bug, feature, new API(s), SEMVER, etc.)
I have added the appropriate milestone and project boards

Goal

The goal here is to add internal package to 1.0 modules and the APIs designed only for local usage

Implementation

Move classes around to internal package
Add internal modifier
Fix package across codebase
Make APIs Java friendly
Remove duplication and never used code
Overall cleanup

Will follow up with #2417 (comment) (added TODOs in the code)

Testing

I have tested locally (including SNAPSHOT upstream dependencies if needed) through testapp/demo app and run all activities to avoid regressions
I have tested via a test drive, or a simulation/mock location app
New and existing unit tests pass locally with my changes

Checklist

My code follows the style guidelines of this project
I have performed a self-review of my own code
I have updated the CHANGELOG including this PR

codecov-io · 2020-04-25T01:46:19Z

Codecov Report

Merging #2839 into master will increase coverage by 0.04%.
The diff coverage is 55.95%.

@@             Coverage Diff              @@
##             master    #2839      +/-   ##
============================================
+ Coverage     35.00%   35.05%   +0.04%     
- Complexity     2107     2108       +1     
============================================
  Files           541      543       +2     
  Lines         19422    19390      -32     
  Branches       1841     1841              
============================================
- Hits           6799     6797       -2     
+ Misses        11807    11777      -30     
  Partials        816      816

kmadsen · 2020-04-28T16:46:29Z

libnavigation-core/src/main/java/com/mapbox/navigation/core/telemetry/events/FeedbackEvent.kt

+        INCORRECT_AUDIO_GUIDANCE
    )
-    annotation class FeedbackType
+    annotation class Type


are you sure you want to change this to Type? to be consistent, looks you'll want to follow up and change all of these 🤔

Also there are enough "Type" objects

BicycleType is an enum. It's also for the Onboard module (not actively under development at the moment) so for now I'm going to leave it as is.
DirectionsRouteType is from the legacy.

kmadsen · 2020-04-28T16:46:58Z

libnavigation-core/src/main/java/com/mapbox/navigation/core/telemetry/events/FeedbackEvent.kt

+        UI
    )
-    annotation class FeedbackSource
+    annotation class Source


out of scope of a package change: https://github.com/mapbox/mapbox-navigation-android/pull/2839/files#r416766318

but also my preference is FeedbackSource. There's already a few "Source" objects

kmadsen · 2020-04-28T16:48:36Z

libnavigation-util/src/test/java/com/mapbox/navigation/utils/internal/ThreadControllerTest.kt

+        val jobControl = ThreadController.getIOScopeAndRootJob()
+        (0 until maxCoroutines).forEach {
+            jobControl.scope.launch {
+                delay(maxDelay)


= coroutineRule.runBlockingTest

this will delay the test thread no?

oh this change was ThreadControllerKtTest to ThreadControllerTest. up to you to update

Actually this doesn't affect the test as the launch is async i.e. the delay is not blocking.

kmadsen · 2020-04-28T16:49:30Z

libnavigation-core/src/main/java/com/mapbox/navigation/core/replay/route/ReplayLocationDto.kt

-import com.google.gson.annotations.SerializedName
-import java.util.Date
-
-internal data class ReplayLocationDto(


Guardiola31337 · 2020-04-28T21:48:17Z

libnavigation-core/src/main/java/com/mapbox/navigation/core/MapboxNavigation.kt

        fun postUserFeedback(
-            @FeedbackEvent.FeedbackType feedbackType: String,
+            @FeedbackEvent.Type feedbackType: String,
            description: String,


Not adding @FeedbackEvent.Description for now cc @JunDai

Guardiola31337 · 2020-04-28T21:49:45Z

...igation-core/src/main/java/com/mapbox/navigation/core/telemetry/MapboxNavigationTelemetry.kt

    override fun postUserFeedback(
-        @FeedbackEvent.FeedbackType feedbackType: String,
+        @FeedbackEvent.Type feedbackType: String,
        description: String,


Not adding @FeedbackEvent.Description for now cc @JunDai

Guardiola31337 · 2020-04-28T21:50:08Z

...igation-core/src/main/java/com/mapbox/navigation/core/telemetry/MapboxNavigationTelemetry.kt

    private fun postUserFeedbackHelper(
-        @FeedbackEvent.FeedbackType feedbackType: String,
+        @FeedbackEvent.Type feedbackType: String,
        description: String,


Same as above re: @FeedbackEvent.Description cc @JunDai

Guardiola31337 · 2020-04-28T21:50:21Z

...ore/src/main/java/com/mapbox/navigation/core/telemetry/MapboxNavigationTelemetryInterface.kt

    fun postUserFeedback(
-        @FeedbackEvent.FeedbackType feedbackType: String,
+        @FeedbackEvent.Type feedbackType: String,
        description: String,


Same as above re: @FeedbackEvent.Description cc @JunDai

Guardiola31337 added ✓ ready for review backwards incompatible Requires a SEMVER major version change. Core Work related to core navigation and integrations. labels Apr 25, 2020

Guardiola31337 added this to the v1.0.0 milestone Apr 25, 2020

Guardiola31337 requested review from JunDai, Lebedinsky, LukasPaczos, RingerJK, abhishek1508, cafesilencio and kmadsen April 25, 2020 00:59

Guardiola31337 self-assigned this Apr 25, 2020

Guardiola31337 force-pushed the pg-internal-libnavigation-core branch 2 times, most recently from a597570 to 107a1d2 Compare April 25, 2020 01:30

Guardiola31337 force-pushed the pg-internal-libnavigation-core branch 2 times, most recently from 2098246 to 03c679a Compare April 28, 2020 14:23

kmadsen reviewed Apr 28, 2020

View reviewed changes

kmadsen approved these changes Apr 28, 2020

View reviewed changes

abhishek1508 approved these changes Apr 28, 2020

View reviewed changes

add internal package to libnavigation-core

bb7e637

Guardiola31337 force-pushed the pg-internal-libnavigation-core branch from 03c679a to bb7e637 Compare April 28, 2020 21:46

Guardiola31337 commented Apr 28, 2020

View reviewed changes

Guardiola31337 added the UI Work related to visual components, Android Auto, Camera, 3D, voice, etc. label Apr 28, 2020

Guardiola31337 merged commit 76eb99b into master Apr 28, 2020

Guardiola31337 deleted the pg-internal-libnavigation-core branch April 28, 2020 23:13

This was referenced Apr 29, 2020

Clean up MapboxNativeNavigator #2862

Merged

Internal package tailwork #2863

Closed

Add internal package to libnavigation-core #2839

Add internal package to libnavigation-core #2839

Uh oh!

Conversation

Guardiola31337 commented Apr 25, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Goal

Implementation

Testing

Checklist

Uh oh!

codecov-io commented Apr 25, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Guardiola31337 commented Apr 25, 2020 •

edited

Loading

codecov-io commented Apr 25, 2020 •

edited

Loading